package com.android.controller;

/**
 * Word Set Class - Creates a word set for a specific word. It contains word,
 * hint1, hint2, hint3.
 * 
 * @author David Alban
 * @version 1.0 
 */
public class WordSet
{
	/**
	 * String representation of the word to be drawn.
	 */
	private String word;
	/**
	 * Part of speech of word 
	 * 
	 * Adjective		describes a noun
	 * Adverb			describes a verb, adjective or adverb
	 * Conjunction		joins clauses or sentences or words
	 * Interjection		short exclamation, sometimes inserted into a sentence
	 * Noun				thing or person
	 * Preposition		links a noun to another word
	 * Pronoun			replaces a noun
	 * Verb				action or state
	 */ 
	private String wordType;
	/**
	 * String representation of the first hint on the word 
	 */
	private String hint1;
	/**
	 * String representation of the second hint on the word 
	 */
	private String hint2;
	
	/**
	 * Constructor - Initializes the word set class.
	 */
	public WordSet()
	{
		word = "";
		wordType = "";
		hint1 = "";
		hint2 = "";
	}
	
	/**
	 * Constructor - Initializes the word set class with the given parameters.
 	 * @param Word		Word to be drawn
 	 * @param WordType	Part of speech of word
 	 * @param Hint1		First hint on the word
 	 * @param Hint2		Second hint on the word
	 */
	public WordSet(String Word, String WordType, String Hint1, String Hint2)
	{
		word = Word;
		wordType = WordType;
		hint1 = Hint1;
		hint2 = Hint2;
	}
	
	/**
	 * Accessor Method - Returns the word to be drawn.
	 * @return	word		Word to be drawn
	 */
	public String getWord()
	{
		return word;
	}
	
	/**
	 * Accessor Method - Returns the word type.
	 * @return wordType		Word type
	 */
	public String getWordType()
	{
		return wordType;
	}
	
	/**
	 * Accessor Method - Returns the first hint on the word.
	 * @return	hint1		First hint on the word
	 */
	public String getHint1()
	{
		return hint1;
	}
	
	/**
	 * Accessor Method - Returns the second hint on the word.
	 * @return	hint2		Second hint on the word
	 */
	public String getHint2()
	{
		return hint2;
	}
	
	/**
	 * Modifier Method - Sets the word to be drawn.	
	 * @param	word		Word to be drawn
	 */
	public void setWord(String Word)
	{
		word = Word;
	}

	
	/**
	 * Modifier Method - Sets the word type.	
	 * @param	WordType		Word type
	 */
	public void setWordType(String WordType)
	{
		wordType = WordType;
	}
	
	/**
	 * Modifier Method - Sets the first hint on the word.	
	 * @param	hint1		First hint on the word
	 */
	public void setHint1(String Hint)
	{
		hint1 = Hint;
	}
	
	/**
	 * Modifier Method - Sets the second hint on the word.	
	 * @param	hint2		Second hint on the word
	 */
	public void setHint2(String Hint)
	{
		hint2 = Hint;
	}
}